home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfdoor.zip / SFDOOR.DOC < prev   
Text File  |  1992-03-20  |  11KB  |  268 lines
  1.                                  SFDOOR
  2.                                Version 1.0
  3.                     Copyright (C) by Mike Woltz, 1991
  4.                           Buffalo Creek Software
  5.                                A Member Of 
  6.                  The Association Of Shareware Professionals
  7.     
  8.  
  9.     INTRODUCTION
  10.     ------------
  11.         SFDOOR is a utility written by Mike Woltz, author of SPITFIRE
  12.     Bulletin Board System.  SFDOOR is written in assembler language
  13.     which contributes to its quick execution and small file size.
  14.     SFDOOR is a utility that allows SPITFIRE Sysops to create, add
  15.     to or delete entries from SPITFIRE's SFDOOR.MNU file.  SFDOOR
  16.     also allows the Sysop to review and/or modify SFDOOR.MNU.
  17.  
  18.  
  19.     USAGE
  20.     -----
  21.        SFDOOR should be executed from SPITFIRE's home directory, where
  22.     SFDOOR.MNU is located.  If you attempt to execute SFDOOR and no
  23.     SFDOOR.MNU is found, SFDOOR.COM will display the following prompt:
  24.     
  25.     SFDOOR.MNU was not found!
  26.     Do you wish to create one? [Y/n]
  27.     
  28.     If you respond with "n", you are returned to the DOS prompt.  Pressing
  29.     Enter or responding with a "y" will display the SFDOOR menu.  If
  30.     you execute SFDOOR and a SFDOOR.MNU is found, the SFDOOR menu
  31.     is automatically displayed.
  32.     
  33.       The SFDOOR menu looks like this:
  34.  
  35.       >>>>>>>>>>> SFDOOR MENU <<<<<<<<<<<<
  36.  
  37.       <A>........Add/Change A Door Listing
  38.       <D>............Delete A Door Listing
  39.       <R>................Review SFDOOR.MNU
  40.       <S>..................Save SFDOOR.MNU
  41.       <Q>.............................Quit
  42.       
  43.       Enter Selection: 
  44.       
  45.     Each option will be discussed individually below to explain how
  46.     it works.
  47.     
  48.     <A>....Add/Change A Door Listing
  49.        
  50.        Selecting this option, produces this submenu:
  51.        
  52.          >>>>>>>>>>> SFDOOR MENU <<<<<<<<<<<<
  53.  
  54.          <A>.............Add New Door Listing
  55.          <C>..Change An Existing Door Listing
  56.  
  57.          Enter Selection:
  58.          
  59.          If for any reason, you have selected this option by
  60.          mistake, pressing the ESC key will return you to the
  61.          original SFDOOR menu.
  62.  
  63.          <A>.............Add New Door Listing
  64.  
  65.            
  66.            After selecting <A>, you are prompted to:
  67.            
  68.            Enter Door Title:
  69.            
  70.            Simply enter the title.  What you enter here will display 
  71.            on the menu as the name for this door.  You will note
  72.            that SFDOOR will automatically capitalize the first
  73.            character of each word in the title.
  74.  
  75.            After entering the title, a second menu appears:
  76.  
  77.            >>>>> DOOR SECURITY ACCESS MENU <<<<<<
  78.  
  79.            <G>..Greater Than Or Equal To Security
  80.            <L>.....Less Than Or Equal To Security
  81.            <E>..................Equal To Security
  82.           
  83.            Enter Selection:
  84.           
  85.            Selecting <G>..Greater Than Or Equal To Security will require
  86.            that only callers with security equal to or greater than
  87.            the security assigned to this door will have access to the
  88.            door.
  89.           
  90.            Selecting <L>..Less Than Or Equal To Security will require
  91.            that only callers with a security equal to or less than the
  92.            security assigned to this door will be granted access to
  93.            the door.
  94.           
  95.            Selecting <E>..Equal To Security will require that only
  96.            callers with a security equal to the security assigned
  97.            to this door will be granted access to the door.
  98.  
  99.  
  100.            The last step required for adding a door is to assign it
  101.            a security level.  SFDOOR will display the prompt:
  102.            
  103.            Enter security level:
  104.           
  105.            and it is here that you can enter any security, ranging
  106.            from 0 up to 9999.
  107.  
  108.           This completes the process required to add a door listing
  109.           to SFDOOR.MNU.  SFDOOR will display the new door listing
  110.           it has added to the SFDOOR.MNU.  An example might look
  111.           like this:
  112.          
  113.           Guess A Number,SEC>=10
  114.          
  115.           SFDOOR will also provide the following prompt:
  116.          
  117.           Your SF.BAT file will probably 
  118.           need to be altered accordingly!
  119.          
  120.           as a reminder that the commands required to execute the
  121.           door must still be set up in your SF.BAT file.
  122.  
  123.  
  124.           It should also be noted that if you attempt to add a door, and
  125.           your SFDOOR.MNU contains the maximum amount of doors allowed
  126.           by SPITFIRE (24), the following prompt will display:
  127.          
  128.           Your maximum amount of door
  129.           listings are already in use!
  130.  
  131.  
  132.           <C>..Change An Existing Door Listing
  133.  
  134.           When you select this option, SFDOOR will display the following
  135.           prompt:
  136.          
  137.           Change which door listing? [A B C D E F]
  138.          
  139.           where [A B C D E F] represents the list of doors and your selection
  140.           should correspond to the door you wish to modify.  [A B C D E F]
  141.           is variable according to the number of doors you have available
  142.           on your system.  If you have the maximum number of doors this 
  143.           would range from A to Z, with the exception of G and Q.
  144.          
  145.           After you have selected the door listing you wish to modify,
  146.           that line of your SFDOOR.MNU will be displayed to the screen.
  147.           
  148.           You are then prompted with:
  149.          
  150.           Do you wish to continue? [y/N]
  151.          
  152.           N will return you to the menu, Y will allow you to make 
  153.           changes to the listing selected.
  154.          
  155.           From this point, changing a door listing is very similar
  156.           to adding a new door listing.  You are prompted to enter
  157.           the door title, the security access of G, L or E (as
  158.           described above) and the security that will be assigned
  159.           to the door.  Again, when you have completed your modifications
  160.           SFDOOR will display a reminder that your SF.BAT may need to
  161.           be modified.
  162.  
  163.     <D>.............Delete A Door Listing
  164.  
  165.        When you select this option, SFDOOR will display the following
  166.        prompt:
  167.          
  168.        Delete which door listing? [A B C D E F]
  169.          
  170.        where [A B C D E F] represents the list of doors and your selection
  171.        should correspond to the door you wish to delete.  [A B C D E F]
  172.        is variable according to the number of doors you have available
  173.        on your system.  If you have the maximum number of doors this 
  174.        would range from A to Z, with the exception of G and Q.
  175.          
  176.        After you have selected the door listing you wish to delete, that
  177.        line of your SFDOOR.MNU will be displayed to the screen.
  178.           
  179.        You are then prompted with:
  180.          
  181.        Do you wish to continue? [y/N]
  182.          
  183.        N will return you to the menu, Y will remove that line from the
  184.        door listing of SFDOOR.MNU, thus, deleting the door.
  185.  
  186.        SFDOOR will also provide the following prompt:
  187.          
  188.        Your SF.BAT file will probably 
  189.        need to be altered accordingly!
  190.          
  191.        This is extremely important when deleting a door!  When a line
  192.        is deleted from SFDOOR.MNU, the lines that follow are now each
  193.        associated with a new letter.  Therefore, the letter associated
  194.        with each door no longer corresponds to the letter previously
  195.        associated with that particular door.
  196.        
  197.        As an example, let's assume a board has 3 doors; A, B and C.
  198.        If door B is deleted when the changes are saved, the listing is 
  199.        removed from SFDOOR.MNU and what was door C now becomes door B.
  200.        
  201.        Therefore, it becomes extremely important to ensure your SF.BAT
  202.        commands correspond to the appropriate door.
  203.        
  204.     
  205.     <R>...............Review SFDOOR.MNU
  206.  
  207.        Selecting this option, will display the contents of the SFDOOR.MNU
  208.        file.  If you have made any changes since beginning SFDOOR, those
  209.        changes will also be displayed, even though the changes have not
  210.        been saved.  When reviewing the SFDOOR.MNU, if you have a large
  211.        number of doors, the screen will fill and you are prompted to
  212.        Press your favorite key to continue..., to continue reviewing the
  213.        remainder of the list.  After the entire door listing has displayed
  214.        you are again be prompted with, Press your favorite key to 
  215.        continue..., which will return you to the SFDOOR menu.
  216.  
  217.     <S>.................Save SFDOOR.MNU
  218.  
  219.        Selecting this option, will save the SFDOOR.MNU file. However,
  220.        if you attempt to quit without saving your changes, SFDOOR
  221.        will prompt you to save the modifications you have made.
  222.         
  223.  
  224.     <Q>..............................Quit
  225.        
  226.        Selecting this option, returns you to the DOS prompt.  If you
  227.        have selected Quit, after making changes to your SFDOOR.MNU
  228.        file and not saved the changes, SFDOOR will prompt you with:
  229.        
  230.        Save changes? [Y/n]
  231.        
  232.        Selecting "y" will allow the modifications made to the SFDOOR.MNU
  233.        file to be saved prior to returning to DOS.  Selecting "n" ignores
  234.        any changes made and simply returns you to the DOS prompt.
  235.  
  236.        Pressing the ESC key will produce the same results as selecting
  237.        <Q> to Quit.  If you have made changes, you will be prompted
  238.        as to whether the changes should be saved and if no changes have
  239.        been made, you are simply returned to the DOS prompt.
  240.  
  241.     
  242.     DISTRIBUTION
  243.     ------------
  244.  
  245.        SFDOOR is distributed under the shareware concept.  You are
  246.     free to distribute the SFDOOR program as long as it remains
  247.     unmodified and no fee is charged.  If you continue to use this 
  248.     program after an adequate evaluation period a fee is required.
  249.     A $1.00 fee is required of register SFDOOR.
  250.  
  251.  
  252.     DISCLAIMER
  253.     ----------
  254.         
  255.        Mike Woltz and/or Buffalo Creek Software shall in no way be 
  256.     held responsible for any damage incurred while operating SFDOOR.
  257.     All responsibility lies with the user of the software.
  258.  
  259.        The documentation for SFDOOR is contributed by Jacque
  260.     Shipley and The Mother Board BBS.  The shareware version of
  261.     SPITFIRE and other SPITFIRE utilities are available for download
  262.     from:
  263.  
  264.          Buffalo Creek's BBS              The Mother Board BBS
  265.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  266.            (515) 225-8496                    (515) 986-3464
  267.     38400/19200/9600/2400/1200 Baud      19200/9600/2400/1200 Baud
  268.